docs: contribution guide for docs #2962
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add a new guide for writing API docs, which pins down the format for descriptions and summaries of APIs, operations, and parameters. Also support rendering correct quotes instead of plain ones.:
✗ The generated branch has been deleted.If the PR has been merged, you can check the generated code on the |
shortcuts
previously approved these changes
Apr 7, 2024
shortcuts
previously approved these changes
Apr 7, 2024
shortcuts
approved these changes
Apr 8, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🧭 What and Why
Improve contribution guidelines for adding new clients and the documentation aspects of it.
Changes included:
remark-smartypantsplugin to render straight quotes as "correct" quotes.I'll update the specs to follow these guidelines in a separate PR.